Interface HandlerInterface

Summary

Fully Qualified Name: CodeIgniter\Log\Handlers\HandlerInterface

Description

Expected behavior for a Log handler

Methods

Name Description Defined By
canHandle() Checks whether the Handler will handle logging items of this log Level. HandlerInterface
handle() Handles logging the message. HandlerInterface
setDateFormat() Sets the preferred date format to use when logging. HandlerInterface

Method Details

canHandle()

Checks whether the Handler will handle logging items of this log Level.

Parameter Name Type Description
$level string

Returns: bool

handle()

Handles logging the message.

If the handler returns false, then execution of handlers will stop. Any handlers that have not run, yet, will not be run.

Parameter Name Type Description
$message
$level
$message

Returns: bool

setDateFormat()

Sets the preferred date format to use when logging.

Parameter Name Type Description
$format string

Returns: \HandlerInterface

Top